Creation information for a frame buffer. More...

#include <kanzi/gfx/create_info.hpp>

Inheritance diagram for kanzi::gfx::FrameBufferCreateInfo:

Classes
struct	Attachment
	Attachment definition. More...

Public Types
using	HandleType
	Frame buffer handle.

Public Attributes
FixedArray< Attachment, limits::MaxColorAttachments >	colorAttachments
	Color attachment definitions. Used only when surfaceHandle is nullptr.

Attachment	depthStencilAttachment
	Depth stencil attachment definition. Used only when surfaceHandle is nullptr.

v2u32	surfaceDimensions
	The surface dimensions in pixels. Used only when surfaceHandle is not nullptr.

platform::NativeSurfaceHandle	surfaceHandle
	The platform-specific window handle used to create an on-screen surface.

platform::SurfaceProperties	surfaceProperties
	The desired properties of the on-screen surface.

Public Attributes inherited from kanzi::gfx::BaseCreateInfo
string_view	name
	The name of the graphics object, useful for debugging.

Detailed Description

Creation information for a frame buffer.

This can represent either:

A frame buffer backed by a separate image resource
An on-screen surface backed by the platform

Since: Kanzi 4.0.0

Member Typedef Documentation

◆ HandleType

using kanzi::gfx::FrameBufferCreateInfo::HandleType

Frame buffer handle.

Member Data Documentation

◆ colorAttachments

FixedArray<Attachment, limits::MaxColorAttachments> kanzi::gfx::FrameBufferCreateInfo::colorAttachments

Color attachment definitions. Used only when surfaceHandle is nullptr.

◆ depthStencilAttachment

Attachment kanzi::gfx::FrameBufferCreateInfo::depthStencilAttachment

Depth stencil attachment definition. Used only when surfaceHandle is nullptr.

◆ surfaceHandle

platform::NativeSurfaceHandle kanzi::gfx::FrameBufferCreateInfo::surfaceHandle

The platform-specific window handle used to create an on-screen surface.

On Windows, this HWND, on Android, ANativeWindow*, and so on. When this is non-nullptr, the attachment definitions are ignored. The lifetime of the window must be longer than the lifetime of the frame buffer.

◆ surfaceDimensions

v2u32 kanzi::gfx::FrameBufferCreateInfo::surfaceDimensions

The surface dimensions in pixels. Used only when surfaceHandle is not nullptr.

◆ surfaceProperties

platform::SurfaceProperties kanzi::gfx::FrameBufferCreateInfo::surfaceProperties

The desired properties of the on-screen surface.

Used only when surfaceHandle is not nullptr. If the set of surface properties does not match exactly what is provided, the surface uses a set of fallback properties.

The documentation for this struct was generated from the following file:

kanzi/gfx/create_info.hpp

Classes

Public Types

Public Attributes